home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / sqaem100.zip / SQAEM.DOC < prev    next >
Text File  |  1992-02-25  |  6KB  |  123 lines
  1. Squish Automatic Echo Manager                   (C) 1992 Copyright Rui Pereira
  2. SQAEM v1.00                                                All rights reserved
  3. ------------------------------------------------------------------------------
  4.  
  5.                                    SQAEM v1.00
  6.  
  7.                                 - Feb. 22, 1992 -
  8.  
  9.  
  10. I had a dream.  There were mountains and mountains of documentation...Actually
  11. it was more like a nightmare.  With that in mind, I'll make this documentation
  12. brief and to the point.
  13.  
  14. SQAEM (pronounced "scream" without the R) is a utility used with Squish Echo
  15. Processor.  It allows the nodes you distribute echoes to to make changes in the
  16. echoes that they receive.  It allows them to add or delete echoes all
  17. automatically without your manual intervention.
  18.  
  19. SQAEM uses the Squish config file to store all of its data, so you will not
  20. need another configuration file.  It also EXPECTS to find information on echoes
  21. inside this file and no where else.  Thus you can not run SQAEM with Squish if
  22. you are using an AREAS.BBS file.  SQAEM eliminates the need for a separate
  23. AREAS.BBS file.
  24.  
  25. SQAEM will look for any message in the netmail area that is addressed to your
  26. node or aka's, and has a name of AREAFIX (this can be changed, keep reading).
  27. SQAEM expects to see the node's password in the subject line and a list of
  28. echoes to add and/or delete in the body of the text.  There can also be a list
  29. and or query command after the password in the subject line.  This follows the
  30. AREAFIX standard started by George Peace and his original version of AREAFIX.
  31.  
  32. The following is the syntax for SQAEM:
  33.  
  34. SQAEM [options] <Squish CFG file>
  35.  
  36. Options:
  37.       -n<name>   Look for <name> instead of AREAFIX.  You can have multiple
  38.                  -n parameters.  The first one overwrites the AREAFIX default.
  39.       -m<number> Maximum number of characters to allocate for the
  40.                  area's long description (default is 4096)
  41.       -a<zone:net/node.point> AKA node number(s)
  42.       -c         Check for Zone and Point info in message text
  43.                  (^aINTL, ^aTOPT, ^aFMPT)
  44.       -z         Don't compare Zone and Point values
  45.       -h         This help page
  46.  
  47.  
  48. The following are the keywords that SQAEM looks for in the Squish configuration
  49. file and their meaning:
  50.  
  51.         NetArea The directory where NetMail is kept
  52.         Address Your node address (4D) and akas
  53.         LogFile The location and name of the Squish Log file
  54.  
  55.         EchoArea        The name, options, and nodes that subscribe to an echo
  56.         ;EchoSDesc      A one line description of the echo.  This keyword is
  57.                         used for the Query command and should be more than 60
  58.                         characters.
  59.         ;EchoLDesc      Multi line (more than one ;EchoLDesc statement)
  60.                         description of the echo.  This keyword is used for the
  61.                         List command. Each line should not be more than 60
  62.                         characters.
  63.         ;EchoGrp        The group letter of the echo (A-F, 0-9)
  64.         ;EchoLevel      The Level (0-2^16) of the echo
  65.  
  66.         ;Node           The node number (4D) of a node that subscribes to some
  67.                         of your echoes
  68.         ;NodeGrps       The groups that this node has access to (A-F, 0-9)
  69.         ;NodeLevel      The level of this node
  70.         ;NodePass       The case-sensitive password for this node
  71.         ;NodeFlag       The Fido attributes for this node
  72.                         (Crash, Hold, Kill, Local, RRQ (Return Request),
  73.                         Direct, IMM (Immedeate))
  74.  
  75. A node record has to start with the ;Node keyword.  All other node related
  76. keywords after it and before the next ;Node keyword are part of it.
  77.  
  78. An echo record has to start with the EchoArea keyword.  All other echo related
  79. keywords after it and before the next EchoArea keyword are part of it.
  80.  
  81. Here is an example of an incomplete Squish configuration file:
  82.  
  83. ;Node 1:163/508
  84. ;NodeGrps B
  85. ;NodePass passWord
  86. ;NodeFlag Crash Local Kill
  87. ;NodeLevel 10
  88.  
  89. EchoArea  ASIA            L:\PCB\CONF88\    -s        278/607 163/520
  90. ;EchoSDesc News on China,Tibet,Indonesia,Cambodia(Source 1:278/607)
  91. ;EchoLDesc News on events in China, Tibet, Indonesia, Cambodia.
  92. ;EchoLDesc Moderator: William Bowles (1:278/607)
  93. ;EchoLDesc
  94. ;EchoGrp N
  95. ;EchoLevel 10
  96.  
  97. ------------------------------------------------------------------------------
  98. Future enhancements include:
  99.  - Automatically areafixing your distributors to add echoes that you do not
  100.    carry, but your feeds have requested
  101.  - Screen output
  102. ------------------------------------------------------------------------------
  103. This piece of software is being distributed as ShareWare.  If you use it
  104. regularly please register it by sending $25.00 to the author.
  105. As with any ShareWare program, I do not take any responsibility for this
  106. program's behaviour.
  107. ------------------------------------------------------------------------------
  108. Squish, Fido, and AreaFix are all trademarks of their respective manufacturers.
  109. SQAEM is copyrighten by Rui Pereira and Merlin Systems.
  110. ------------------------------------------------------------------------------
  111. Author:         Rui Pereira
  112.  
  113. Postal:         Merlin Systems
  114.                 P.O. Box 3043, Station "C"
  115.                 Ottawa, Ontario, Canada
  116.                 KiY 4J3
  117.  
  118. InterNet:       Roy.Pereira%mersys@devcan.ca
  119.  
  120. UUCP:           mersys!Roy.Pereira
  121.  
  122. FidoNet:        Roy Pereira at 1:163/508.1
  123.